Skip to main content

API docs

I have created a lot of documentation for developers over the years. I have also taken several courses about how to create API docs.

Please browse the following sections to see examples of things I’ve done in the areas of API docs, Docs-As-Code tools, github versioning and deployment, jekyll, and sphinx.

Github site example​

To further demonstrate my capabilities to work with modern developer doc tools, I used github to build, edit, version, and deploy my full portfolio site.

Docusaurus example​

I created the portfolio you're currently viewing to demonstrate my capabilities with writing, editing, styling (CSS), building, and deploying Docusaurus sites. To see some examples of API docs that I created with Docusaurus, select Next to go to the next page.

Jekyll example​

I've also built an example of a developer style of site with jekyll. I built the site in a github repo and hosted it on github pages. You can see it here.

OpenAPI example​

I created an API documentation site on github that uses data from the Swagger PetStore Sample API. I built the site with the highly respected and most commonly used specification: OpenAPI. I'm very experienced with CSS, so I can style sites like this to fit any branding and format that a company needs. You can see this site here.

Madcap Flare example​

If you use Madcap Flare to create your Help content, you might want to also use Flare to create and maintain your API documentation. Here are two API reference examples that I created with Flare. I built these in a github repo. This could provide a method to use Flare to maintain your API documentation, rather than use Jekyll, Hugo, Sphinx, or the many other Docs As Code tool sets.

You can see an example with a one column format here. You can see an example with a two column format here.

Sphinx site example​

I have a similar portfolio site that I built with sphinx to demonstrate what I can do with that tool.

note

I haven’t hosted this site anywhere yet. But I’ll be happy to show it to anyone who asks!

API course certificates​

Also, here are certificates for a few of the API courses that I’ve completed.

Certificate 1

Certificate 2

Certificate 3

LinkedIn profile​

This portfolio is just a small sampling of what I have done and what I can do. If you would like to see more examples or have any questions, feel free to contact me via my LinkedIn profile.

See my profile on LinkedIn.